<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="Patrick T. Komiske III" /><link rel="canonical" href="https://thaler-lab.github.io/Wasserstein/faqs/" />
      <link rel="shortcut icon" href="../img/favicon.ico" />
    <title>FAQs - Wasserstein</title>
    <link rel="stylesheet" href="../css/theme.css" />
    <link rel="stylesheet" href="../css/theme_extra.css" />
        <link href="../css/eftheme.css" rel="stylesheet" />
        <link href="../css/pygmentize_friendly.css" rel="stylesheet" />

      <script>
        // Current page data
        var mkdocs_page_name = "FAQs";
        var mkdocs_page_input_path = "faqs.md";
        var mkdocs_page_url = "/Wasserstein/faqs/";
      </script>

    <script src="../js/jquery-3.6.0.min.js" defer></script>
    <!--[if lt IE 9]>
      <script src="../js/html5shiv.min.js"></script>
    <![endif]-->
      <script>
        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
        })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

        ga('create', 'UA-122962541-3', 'Wasserstein');
        ga('send', 'pageview');
      </script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
    <div class="wy-side-scroll">
      <div class="wy-side-nav-search">
  <a href="..">
    <div class="eflogo">
      <img src="../img/eflogowhite.png"  class="eflogo-img"> Wasserstein
    </div>
  </a><div role="search">
  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
      <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="..">Home</a>
                </li>
              </ul>
              <p class="caption"><span class="caption-text">Getting Started</span></p>
              <ul class="current">
                  <li class="toctree-l1"><a class="reference internal" href="../installation/">Installation</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../demos/">Python Demos</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../examples/">C++ Examples</a>
                  </li>
                  <li class="toctree-l1 current"><a class="reference internal current" href="./">FAQs</a>
    <ul class="current">
    <li class="toctree-l2"><a class="reference internal" href="#why-should-i-use-wasserstein-instead-of-the-python-optimal-transport-pot-library">Why should I use Wasserstein instead of the Python Optimal Transport (POT) library?</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#how-do-i-cite-the-wasserstein-package">How do I cite the Wasserstein package?</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#where-can-i-get-the-code">Where can I get the code?</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#how-do-i-report-an-issue">How do I report an issue?</a>
    </li>
    </ul>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../releases/">Release Notes</a>
                  </li>
              </ul>
              <p class="caption"><span class="caption-text">Documentation</span></p>
              <ul>
                  <li class="toctree-l1"><a class="reference internal" href="../docs/emd/">EMD</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../docs/emds/">PairwiseEMD</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../docs/externalemdhandler/">External EMD Handlers</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../docs/event/">Events</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../docs/pairwisedistance/">Pairwise Distance</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../docs/utils/">Utils</a>
                  </li>
              </ul>
      </div>
    </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
      <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="..">Wasserstein</a>

      </nav>
      <div class="wy-nav-content">
        <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
          <li>Getting Started &raquo;</li><li>FAQs</li>
    <li class="wy-breadcrumbs-aside">
    </li>
  </ul>
  <hr/>
</div>

          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div class="section" itemprop="articleBody">

                <h1 id="frequently-asked-energyflow-questions">Frequently Asked EnergyFlow Questions</h1>
<ul>
<li><a href="#why-should-i-use-wasserstein-instead-of-the-python-optimal-transport-pot-library">Why should I use Wasserstein instead of the Python Optimal Transport (POT) library?</a></li>
<li><a href="#how-do-i-cite-the-wasserstein-package">How do I cite the Wasserstein package?</a></li>
<li><a href="#where-can-i-get-the-code">Where can I get the code?</a></li>
<li><a href="#how-do-i-report-an-issue">How do I report an issue or a bug?</a></li>
</ul>
<hr />
<h2 id="why-should-i-use-wasserstein-instead-of-the-python-optimal-transport-pot-library">Why should I use Wasserstein instead of the Python Optimal Transport (POT) library?</h2>
<p><a href="https://pythonot.github.io/">POT</a> offers EMD functionality based on the same algorithm as Wasserstein. You'll find that Wasserstein is faster (up to 2x) for small problems (around 100 particles) due to the more efficient way in which we interface with NumPy. Also, Wasserstein offers greater numerical flexibility, with the ability to control certain floating point epsilons that POT hard codes and can cause failure (especially on macOS, we have found). And then there is the C++ interface that Wasserstein exposes in case you work in that language.</p>
<h2 id="how-do-i-cite-the-wasserstein-package">How do I cite the Wasserstein package?</h2>
<p>Please cite the relevant papers if they or this package help your research. Here are the BibTeX entries to use:</p>
<div class="codehilite"><pre><span></span><code><span class="nc">@article</span><span class="p">{</span><span class="nl">10.1145/2070781.2024192</span><span class="p">,</span>
  <span class="na">author</span>     <span class="p">=</span> <span class="s">&quot;Bonneel, Nicolas and van de Panne, Michiel and Paris, Sylvain and Heidrich, Wolfgang&quot;</span><span class="p">,</span>
  <span class="na">title</span>      <span class="p">=</span> <span class="s">&quot;{Displacement Interpolation Using Lagrangian Mass Transport}&quot;</span><span class="p">,</span>
  <span class="na">year</span>       <span class="p">=</span> <span class="s">&quot;2011&quot;</span><span class="p">,</span>
  <span class="na">issue_date</span> <span class="p">=</span> <span class="s">&quot;December 2011&quot;</span><span class="p">,</span>
  <span class="na">publisher</span>  <span class="p">=</span> <span class="s">&quot;Association for Computing Machinery&quot;</span><span class="p">,</span>
  <span class="na">address</span>    <span class="p">=</span> <span class="s">&quot;New York, NY, USA&quot;</span><span class="p">,</span>
  <span class="na">volume</span>     <span class="p">=</span> <span class="s">&quot;30&quot;</span><span class="p">,</span>
  <span class="na">number</span>     <span class="p">=</span> <span class="s">&quot;6&quot;</span><span class="p">,</span>
  <span class="na">issn</span>       <span class="p">=</span> <span class="s">&quot;0730-0301&quot;</span><span class="p">,</span>
  <span class="na">url</span>        <span class="p">=</span> <span class="s">&quot;https://doi.org/10.1145/2070781.2024192&quot;</span><span class="p">,</span>
  <span class="na">doi</span>        <span class="p">=</span> <span class="s">&quot;10.1145/2070781.2024192&quot;</span><span class="p">,</span>
  <span class="na">journal</span>    <span class="p">=</span> <span class="s">&quot;ACM Trans. Graph.&quot;</span><span class="p">,</span>
  <span class="na">month</span>      <span class="p">=</span> <span class="s">&quot;dec&quot;</span><span class="p">,</span>
  <span class="na">pages</span>      <span class="p">=</span> <span class="s">&quot;1–12&quot;</span><span class="p">,</span>
  <span class="na">numpages</span>   <span class="p">=</span> <span class="s">&quot;12&quot;</span>
<span class="p">}</span>

<span class="nc">@article</span><span class="p">{</span><span class="nl">Komiske:2019fks</span><span class="p">,</span>
  <span class="na">author</span>        <span class="p">=</span> <span class="s">&quot;Komiske, Patrick T. and Metodiev, Eric M. and Thaler, Jesse&quot;</span><span class="p">,</span>
  <span class="na">title</span>         <span class="p">=</span> <span class="s">&quot;{Metric Space of Collider Events}&quot;</span><span class="p">,</span>
  <span class="na">eprint</span>        <span class="p">=</span> <span class="s">&quot;1902.02346&quot;</span><span class="p">,</span>
  <span class="na">archivePrefix</span> <span class="p">=</span> <span class="s">&quot;arXiv&quot;</span><span class="p">,</span>
  <span class="na">primaryClass</span>  <span class="p">=</span> <span class="s">&quot;hep-ph&quot;</span><span class="p">,</span>
  <span class="na">reportNumber</span>  <span class="p">=</span> <span class="s">&quot;MIT-CTP 5102&quot;</span><span class="p">,</span>
  <span class="na">doi</span>           <span class="p">=</span> <span class="s">&quot;10.1103/PhysRevLett.123.041801&quot;</span><span class="p">,</span>
  <span class="na">journal</span>       <span class="p">=</span> <span class="s">&quot;Phys. Rev. Lett.&quot;</span><span class="p">,</span>
  <span class="na">volume</span>        <span class="p">=</span> <span class="s">&quot;123&quot;</span><span class="p">,</span>
  <span class="na">number</span>        <span class="p">=</span> <span class="s">&quot;4&quot;</span><span class="p">,</span>
  <span class="na">pages</span>         <span class="p">=</span> <span class="s">&quot;041801&quot;</span><span class="p">,</span>
  <span class="na">year</span>          <span class="p">=</span> <span class="s">&quot;2019&quot;</span>
<span class="p">}</span>

<span class="nc">@article</span><span class="p">{</span><span class="nl">Komiske:2020qhg</span><span class="p">,</span>
  <span class="na">author</span>        <span class="p">=</span> <span class="s">&quot;Komiske, Patrick T. and Metodiev, Eric M. and Thaler, Jesse&quot;</span><span class="p">,</span>
  <span class="na">title</span>         <span class="p">=</span> <span class="s">&quot;{The Hidden Geometry of Particle Collisions}&quot;</span><span class="p">,</span>
  <span class="na">eprint</span>        <span class="p">=</span> <span class="s">&quot;2004.04159&quot;</span><span class="p">,</span>
  <span class="na">archivePrefix</span> <span class="p">=</span> <span class="s">&quot;arXiv&quot;</span><span class="p">,</span>
  <span class="na">primaryClass</span>  <span class="p">=</span> <span class="s">&quot;hep-ph&quot;</span><span class="p">,</span>
  <span class="na">reportNumber</span>  <span class="p">=</span> <span class="s">&quot;MIT-CTP 5185&quot;</span><span class="p">,</span>
  <span class="na">doi</span>           <span class="p">=</span> <span class="s">&quot;10.1007/JHEP07(2020)006&quot;</span><span class="p">,</span>
  <span class="na">journal</span>       <span class="p">=</span> <span class="s">&quot;JHEP&quot;</span><span class="p">,</span>
  <span class="na">volume</span>        <span class="p">=</span> <span class="s">&quot;07&quot;</span><span class="p">,</span>
  <span class="na">pages</span>         <span class="p">=</span> <span class="s">&quot;006&quot;</span><span class="p">,</span>
  <span class="na">year</span>          <span class="p">=</span> <span class="s">&quot;2020&quot;</span>
<span class="p">}</span>
</code></pre></div>

<h2 id="where-can-i-get-the-code">Where can I get the code?</h2>
<p>The code is open source and hosted on <a href="https://www.github.com/thaler-lab/Wasserstein/">GitHub</a>.</p>
<h2 id="how-do-i-report-an-issue">How do I report an issue?</h2>
<p>Please report any issues you encounter by creating a GitHub <a href="https://github.com/thaler-lab/Wasserstein">Issue</a>.</p>
            </div>
          </div><footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
        <a href="../examples/" class="btn btn-neutral float-left" title="C++ Examples"><span class="icon icon-circle-arrow-left"></span> Previous</a>
        <a href="../releases/" class="btn btn-neutral float-right" title="Release Notes">Next <span class="icon icon-circle-arrow-right"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
      <p>Copyright (C) 2019-2021 Patrick T. Komiske III</p>
  </div>

  Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

        </div>
      </div>

    </section>

  </div>

  <div class="rst-versions" role="note" aria-label="Versions">
  <span class="rst-current-version" data-toggle="rst-current-version">

        <span>
          <a href="https://github.com/thaler-lab/Wasserstein/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
        </span>


      <span><a href="../examples/" style="color: #fcfcfc">&laquo; Previous</a></span>


      <span><a href="../releases/" style="color: #fcfcfc">Next &raquo;</a></span>

  </span>
</div>
    <script>var base_url = '..';</script>
    <script src="../js/theme_extra.js" defer></script>
    <script src="../js/theme.js" defer></script>
      <script src="../js/extra.js" defer></script>
      <script src="https://polyfill.io/v3/polyfill.min.js?features=es6" defer></script>
      <script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js" defer></script>
      <script src="../search/main.js" defer></script>
    <script defer>
        window.onload = function () {
            SphinxRtdTheme.Navigation.enable(true);
        };
    </script>

</body>
</html>
